<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class CPSApiWidget</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class CPSApiWidget</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-consts">Constants</a>
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The CPSApiWidget is the base class for all Pogostick widgets for Yii</p>
	<ul class="tags">
				<li><span class="field">author:</span> Jerry Ablan &lt;<a href="mailto:jablan@pogostick.com">jablan@pogostick.com</a>&gt;</li>
				<li><span class="field">version:</span> SVN: $Id: CPSApiWidget.php 233 2009-06-10 23:54:16Z jerryablan@gmail.com $</li>
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">since:</span> 1.0.3</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_pogostick---base---CPSApiWidget.php.html">/pogostick/base/CPSApiWidget.php</a> (line <span class="field">22</span>)
		</p>
		
				
		<pre>CInputWidget
   |
   --<a href="../../psYiiExtensions/Base/CPSWidget.html">CPSWidget</a>
      |
      --CPSApiWidget</pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-vars">Vars</a>
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-consts">Constants</a>
							
					</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../psYiiExtensions/Components/CPSFacebookConnect.html">CPSFacebookConnect</a></td>
					<td>
											CPSFacebookConnect provides an interface to <a href="http://developers.facebook.com/connect.php">Facebook Connect</a>
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../psYiiExtensions/Widgets/CPSgApiWidget.html">CPSgApiWidget</a></td>
					<td>
											CPSgApiWidget provides access to the <a href="http://code.google.com/apis/ajaxsearch/">Google AJAX APIs</a>
										</td>
				</tr>
							</table>
		</div>
	</div>



	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-consts">Constants</a>
							
															<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																				
												<div class="method-definition">
											<span class="method-result">CPSApiWidget</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											([<span class="var-type"></span>&nbsp;<span class="var-name">$oOwner</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#afterApiCall" title="details" class="method-name">afterApiCall</a>
											(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#beforeApiCall" title="details" class="method-name">beforeApiCall</a>
											(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#events" title="details" class="method-name">events</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#generateHtml" title="details" class="method-name">generateHtml</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#generateJavascript" title="details" class="method-name">generateJavascript</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#makeMapArray" title="details" class="method-name">makeMapArray</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$sApiName</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$sSubApiName</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$arMap</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$bSetRequestMap</span> = <span class="var-default">true</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#makeMapItem" title="details" class="method-name">makeMapItem</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$sLabel</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$sParamName</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$bRequired</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$arOptions</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$arTargetArray</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#onAfterApiCall" title="details" class="method-name">onAfterApiCall</a>
											(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#onBeforeApiCall" title="details" class="method-name">onBeforeApiCall</a>
											(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#onRequestComplete" title="details" class="method-name">onRequestComplete</a>
											(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#requestComplete" title="details" class="method-name">requestComplete</a>
											(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-consts">Constants</a>
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../psYiiExtensions/Base/CPSWidget.html">CPSWidget</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#var$m_arBehaviors">CPSWidget::$m_arBehaviors</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#var$m_bHasBehaviors">CPSWidget::$m_bHasBehaviors</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#var$m_sInternalName">CPSWidget::$m_sInternalName</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#var$m_sPrefixDelimiter">CPSWidget::$m_sPrefixDelimiter</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-vars">Vars</a>
																			<a href="#sec-consts">Constants</a>
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">32</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">CPSApiWidget</span>
		<span class="method-name">
			__construct
		</span>
					([<span class="var-type"></span>&nbsp;<span class="var-name">$oOwner</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$oOwner</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../psYiiExtensions/Base/CPSWidget.html#method__construct">CPSWidget::__construct()</a></dt>
						<dd>Attach behaviors during construction...</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../../psYiiExtensions/Components/CPSFacebookConnect.html#method__construct">CPSFacebookConnect::__construct()</a>
								: Our init function
							</li>
					<li>
				<a href="../../psYiiExtensions/Widgets/CPSgApiWidget.html#method__construct">CPSgApiWidget::__construct()</a>
								: Constructor
							</li>
				</ul>
	</div>
<a name="methodafterApiCall" id="afterApiCall"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">afterApiCall</span> (line <span class="line-number">177</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Call to raise the onAfterApiCall event</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			afterApiCall
		</span>
					(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>
				<span class="var-name">$oEvent</span>			</li>
				</ul>
		
			
	</div>
<a name="methodbeforeApiCall" id="beforeApiCall"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">beforeApiCall</span> (line <span class="line-number">157</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Call to raise the onBeforeApiCall event</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			beforeApiCall
		</span>
					(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>
				<span class="var-name">$oEvent</span>			</li>
				</ul>
		
			
	</div>
<a name="methodevents" id="events"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">events</span> (line <span class="line-number">138</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Declares events and the corresponding event handler methods.</p>
	<ul class="tags">
				<li><span class="field">return:</span> events (array keys) and the corresponding event handler methods (array values).</li>
				<li><span class="field">see:</span> CBehavior::events</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			events
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgenerateHtml" id="generateHtml"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">generateHtml</span> (line <span class="line-number">125</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates the javascript code for the widget</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			generateHtml
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../psYiiExtensions/Base/CPSWidget.html#methodgenerateHtml">CPSWidget::generateHtml()</a></dt>
						<dd>Generates the javascript code for the widget</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../../psYiiExtensions/Components/CPSFacebookConnect.html#methodgenerateHtml">CPSFacebookConnect::generateHtml()</a>
							</li>
					<li>
				<a href="../../psYiiExtensions/Widgets/CPSgApiWidget.html#methodgenerateHtml">CPSgApiWidget::generateHtml()</a>
							</li>
				</ul>
	</div>
<a name="methodgenerateJavascript" id="generateJavascript"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">generateJavascript</span> (line <span class="line-number">116</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates the javascript code for the widget</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			generateJavascript
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../psYiiExtensions/Base/CPSWidget.html#methodgenerateJavascript">CPSWidget::generateJavascript()</a></dt>
						<dd>Generates the javascript code for the widget</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../../psYiiExtensions/Components/CPSFacebookConnect.html#methodgenerateJavascript">CPSFacebookConnect::generateJavascript()</a>
							</li>
					<li>
				<a href="../../psYiiExtensions/Widgets/CPSgApiWidget.html#methodgenerateJavascript">CPSgApiWidget::generateJavascript()</a>
							</li>
					<li>
				<a href="../../psYiiExtensions/Widgets/CPSgMapsWidget.html#methodgenerateJavascript">CPSgMapsWidget::generateJavascript()</a>
							</li>
				</ul>
	</div>
<a name="methodmakeMapArray" id="makeMapArray"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">makeMapArray</span> (line <span class="line-number">56</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates an array for requestMap</p>
	<ul class="tags">
				<li><span class="field">return:</span> Returns the constructed array item ready to insert into your requestMap</li>
				<li><span class="field">see:</span> <a href="../../psYiiExtensions/Base/CPSApiWidget.html#methodmakeMapItem">CPSApiWidget::makeMapItem()</a></li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			makeMapArray
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$sApiName</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$sSubApiName</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$arMap</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$bSetRequestMap</span> = <span class="var-default">true</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$arMap</span><span class="var-description">: The map of items to insert into the array. Format is the same as <a href="../../psYiiExtensions/Base/CPSApiWidget.html#methodmakeMapItem">makeMapItem</a></span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$bSetRequestMap</span><span class="var-description">: If false, will NOT insert constructed array into requestMap</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$sApiName</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$sSubApiName</span>			</li>
				</ul>
		
			
	</div>
<a name="methodmakeMapItem" id="makeMapItem"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">makeMapItem</span> (line <span class="line-number">90</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">S  Creates an entry for requestMap and inserts it into the array.</p>
	<ul class="tags">
				<li><span class="field">return:</span> Returns the constructed array item ready to insert into your requestMap</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			makeMapItem
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$sLabel</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$sParamName</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$bRequired</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$arOptions</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$arTargetArray</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$sLabel</span><span class="var-description">: The label or friendly name of this map item</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$sParamName</span><span class="var-description">: The actual parameter name to send to API. If not specified, will default to $sLabel</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$bRequired</span><span class="var-description">: Set to true if the parameter is required</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$arOptions</span><span class="var-description">: If supplied, will merge with generated options</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$arTargetArray</span><span class="var-description">: If supplied, will insert into array</span>			</li>
				</ul>
		
			
	</div>
<a name="methodonAfterApiCall" id="onAfterApiCall"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">onAfterApiCall</span> (line <span class="line-number">187</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Raises the onAfterApiCall event. $oEvent contains &quot;raw&quot; return data</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			onAfterApiCall
		</span>
					(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>
				<span class="var-name">$oEvent</span>			</li>
				</ul>
		
			
	</div>
<a name="methodonBeforeApiCall" id="onBeforeApiCall"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">onBeforeApiCall</span> (line <span class="line-number">167</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Raises the onBeforeApiCall event</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			onBeforeApiCall
		</span>
					(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>
				<span class="var-name">$oEvent</span>			</li>
				</ul>
		
			
	</div>
<a name="methodonRequestComplete" id="onRequestComplete"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">onRequestComplete</span> (line <span class="line-number">207</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Raises the onRequestComplete event. $oEvent contains &quot;processed&quot; return data (if applicable)</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			onRequestComplete
		</span>
					(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>
				<span class="var-name">$oEvent</span>			</li>
				</ul>
		
			
	</div>
<a name="methodrequestComplete" id="requestComplete"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">requestComplete</span> (line <span class="line-number">197</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Call to raise the onRequestComplete event</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			requestComplete
		</span>
					(<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>&nbsp;<span class="var-name">$oEvent</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../psYiiExtensions/Events/CPSApiEvent.html">CPSApiEvent</a></span>
				<span class="var-name">$oEvent</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../psYiiExtensions/Base/CPSWidget.html">CPSWidget</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#method__construct">CPSWidget::__construct()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodattachBehavior">CPSWidget::attachBehavior()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodattachBehaviors">CPSWidget::attachBehaviors()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodgenerateHtml">CPSWidget::generateHtml()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodgenerateJavascript">CPSWidget::generateJavascript()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodgetBehaviorProperty">CPSWidget::getBehaviorProperty()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodgetBehaviors">CPSWidget::getBehaviors()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodgetHasBehaviors">CPSWidget::getHasBehaviors()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodgetInternalName">CPSWidget::getInternalName()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodgetNamePrefix">CPSWidget::getNamePrefix()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodgetPrefixDelimiter">CPSWidget::getPrefixDelimiter()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodhasBehaviorMethod">CPSWidget::hasBehaviorMethod()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodhasBehaviorProperty">CPSWidget::hasBehaviorProperty()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodinit">CPSWidget::init()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodregisterClientScripts">CPSWidget::registerClientScripts()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodsetBehaviorProperty">CPSWidget::setBehaviorProperty()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodsetHasBehaviors">CPSWidget::setHasBehaviors()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodsetInternalName">CPSWidget::setInternalName()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#methodsetPrefixDelimiter">CPSWidget::setPrefixDelimiter()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#method__call">CPSWidget::__call()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#method__get">CPSWidget::__get()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#method__set">CPSWidget::__set()</a></span><br>
											</blockquote>
										
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendants</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-vars">Vars</a>
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Constants</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../psYiiExtensions/Base/CPSWidget.html">CPSWidget</a></span></p>
					<blockquote>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#constBEHAVIOR_META_METHODS">CPSWidget::BEHAVIOR_META_METHODS</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#constBEHAVIOR_META_OBJECT">CPSWidget::BEHAVIOR_META_OBJECT</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#constBEHAVIOR_META_VALID">CPSWidget::BEHAVIOR_META_VALID</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../psYiiExtensions/Base/CPSWidget.html#constBEHAVIOR_META_VARS">CPSWidget::BEHAVIOR_META_VARS</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Mon, 15 Jun 2009 22:58:14 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
	</p>
	</div></body>
</html>